The if (interface) command node includes the following subnode commands:
configuration
routes
status
Each of the subnode commands, and the leaf-node commands attached to them, are described in detail, with parameters and arguments listed for each command.
Examples of command usage are included in the discussions.
The if configuration subnode includes the following leaf-node commands:
addroute
addfailport
delete
modify
new
offline
online
removefailport
show
CLI:
if configuration addroute -ssid spinserver -ifname interface_name -destaddr destination_IP_address -destmask destination_mask -nexthop next_hop_IP_address
GUI: Navigate to the Interfaces → Configuration pane, then select the appropriate interface from the table and run the Add Route command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed, then click Add Route.
-ssid spinserver
This specifies the SpinServer on which the virtual interface is located.
-ifname interface_name
This specifies the name of the virtual interface that is to have a route added to it.
-destaddr destination_IP_address
This specifies the address of the destination that is to be reached.
-destmask destination_mask
This specifies the mask for the destination address.
-nexthop next_hop_IP_address
This specifies the next endpoint for the route.
The following command example adds a route to a virtual interface named vif0 on a server named Server1. The route has a destination address of 192.40.5.1, a destination mask of 255.255.255.0, and a next-hop address of 192.40.6.1.
spinserver::> if configuration addroute -ssid Server1 -ifname vif0 -destaddr 192.40.5.1 -destmask 255.255.255.0 -nexthop 192.40.6.1
CLI:
if configuration addfailport -ssid spinserver -ifname interface_name -ssidto failover_spinserver -netportnameto network_failoverport_name
GUI: Navigate to the Interfaces → Configuration node, then select the appropriate interface from the table and run the Add Failover Port command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed and click Add Failover Port.
The if configuration addfailport command identifies an interface by its SpinServer ID and interface name, and assigns a failover port to the interface. This commands adds a single failover destination. The command can be run multiple times to add multiple destinations.
-ssid spinserver
This is the ID given to the SpinServer.
-ifname interface_name
This is the name given to the interface to which a failover port is assigned.
-ssidto failover_spinserver
This is the ID given to the failover SpinServer.
-netportnameto network_failoverport_name
This is the name given to the failover port.
The following command example identifies an interface named if0 on a server named Server1 and assigns a failover port named serv0 on a server named Server2.
spinserver::> if configuration addfailport -ssid Server1 -ifname if0 -ssidto Server2 -netportnameto serv0
CLI:
if configuration delete -ssid spinserver -ifname interface_name
GUI: Navigate to the Interfaces → Configuration pane, then select the appropriate interface from the table and run the Delete command from the drop-down menu of the action pane.
The if configuration delete command identifies an interface by its SpinServer ID and interface name and removes the interface from the system.
-ssid spinserver
This is the ID given to the SpinServer.
-ifname interface_name
This is the name given to the interface.
The following command example deletes an interface named if0 on a server named Server1.
spinserver::> if configuration delete -ssid Server1 -ifname if0
CLI:
if configuration modify -ssid spinserver -ifname interface_name -ipaddress IP_address -netmask netmask
GUI: Navigate to the Interfaces → Configuration node, then select the appropriate interface from the table and run the Show command from the drop-down menu of the action pane. In the table that is displayed, make the appropriate modifications, then run the Modify command from the drop-down menu.
The if configuration modify command identifies an interface by its SpinServer ID and interface name and enables you to modify its IP address and netmask.
-ssid spinserver
This is the ID given to the SpinServer.
-ifname interface_name
This is the name given to the interface.
-ipaddress IP_address
This is the IP address assigned to the interface.
-netmask netmask
This is the netmask assigned to the interface.
The following command example identifies an interface named if0 on a server named Server1, and changes its IP address to 10.1.1.130 and netmask to 255.255.255.0.
spinserver::> if configuration modify -ssid Server1 -ifname if0 -ipaddress 10.1.1.130 -netmask 255.255.255.0
CLI:
if configuration new -ssid spinserver -ifname interface_name -netportname network_port_name -ipaddress IP_address -netmask netmask
GUI: Navigate to the Interfaces → Configuration node, then click New in the top bar of the action pane. Enter the appropriate values into the table that is displayed and click Create.
The if configuration new command creates an interface and identifies it by its SpinServer ID, interface name, network port name, IP address, and netmask.
-ssid spinserver
This is the ID given to the SpinServer.
-ifname interface_name
This is the name given to the interface.
-netportname network_port_name
This is the name of the port assigned to the interface.
-ipaddress IP_address
This is the IP address assigned to the interface.
-netmask netmask
This is the netmask assigned to the interface.
The following command example creates an interface named if0 on a server named Server1 and sets the interface's net port name to serv1, its IP address to 10.1.1.1400, and its netmask to 255.255.255.0.
spinserver::> if configuration new -ssid Server1 -ifname if0 -netportname serv1 -ipaddress 10.1.1.140 -netmask 255.255.255.0
CLI:
if configuration offline -ssid spinserver -ifname interface_name
GUI: Navigate to the Interfaces → Configuration node, then select the appropriate interface from the table and run the Offline command from the drop-down menu of the action pane.
The if configuration offline command identifies an interface by its SpinServer ID and interface name and designates the interface's status as offline.
-ssid spinserver
This is the ID given to the SpinServer.
-ifname interface_name
This is the name given to the interface.
The following command example identifies an interface named if0 on a server named Server1 and designates the interface's status as offline.
spinserver::> if configuration offline -ssid Server1 -ifname if0
CLI:
if configuration online -ssid spinserver -ifname interface_name
GUI: Navigate to the Interfaces → Configuration node, then select the appropriate interface from the table and run the Online command from the drop-down menu of the action pane.
The if configuration online command identifies an interface by its SpinServer ID and interface name and designates the interface's status as online.
-ssid spinserver
This is the ID given to the SpinServer.
-ifname interface_name
This is the name given to the interface.
The following command example identifies an interface named if0 on a server named Server1 and designates the interface's status as online.
spinserver::> if configuration online -ssid Server1 -ifname if0
CLI:
if configuration removefailport -ssid spinserver -ifname interface_name -ssidfrom failover_spinserver -netportnamefrom network_failoverport_name
GUI: Navigate to the Interfaces → Configuration node, then select the appropriate interface from the table and run the Remove Failover Port command from the drop-down menu of the action pane.
The if configuration removefailport command identifies an interface by its SpinServer ID and interface name and removes a port from the list of possible failover ports for the interface.
-ssid spinserver
This is the ID given to the SpinServer.
-ifname interface_name
This is the name given to the interface.
-ssidfrom failover_spinserver
This is the ID given to the SpinServer from which the failover port is to be removed.
-netportnamefrom network_failoverport_name
This is the name of the port that is to be removed as a failover port for the interface.
The following command example identifies an interface named if0 on a server named Server1 and removes the port named serv0 on the server named Server2 as a failover port.
spinserver::> if configuration removefailport -ssid Server1 -ifname if0 -ssidfrom Server2 -netportnamefrom serv0
CLI:
if configuration show [-ssid spinserver -ifname interface_name]
GUI: Navigate to the Interfaces → Configuration node. To display information about a specific interface, select it from the table and run the Show command from the drop-down menu in the action pane.
The if configuration show command displays information about one interface or all interfaces. After identification is made, the following information about the interface or interfaces is displayed by the system:
SpinServer ID
Name
Network port
IP address
Netmask
Failover port
To display information about one interface, use the command with the parameters. To display configuration information about a list of interfaces in the system, use no parameters.
[-ssid spinserver]
This is the ID given to the SpinServer. This parameter is optional; however, if it is used, the -ifname parameter must also be specified.
[-ifname interface_name]
This is the name given to the interface. This parameter is optional; however, if it is used, the -ssid parameter must also be specified.
The following command example displays configuration information for all interfaces.
spinserver::> if configuration show
SpinServer Name Port IP Address Netmask Failover
ID Port
Server1 clus_if0 clus0 192.168.1.1 255.255.0.0
Server1 serv_if0 serv0 10.5.20.21 255.255.0.0
The following example displays configuration information about the interface named clus_if0 on the server named Server1.
spinserver::> if configuration show -ssid Server1 -ifname clus_if0 SpinServer ID Server1 Name clus_if0 Port clus0 IP Address 192.168.1.1 Netmask 255.255.0.0 Failover Port VIF ID 1 Role Cluster
CLI:
if routes delete -ssid spinserver -ifname interface_name -destaddr destination_IP_address -destmask destination_mask -nexthop next_hop_IP_address
GUI: Navigate to the Interfaces → Routing pane, then select the appropriate route from the table and run the Delete command from the drop-down menu of the action pane.
-ssid spinserver
This specifies the SpinServer on which the virtual interface is located.
-ifname interface_name
This specifies the name of the virtual interface that is to have a route deleted from it.
-destaddr destination_IP_address
This specifies the route's destination IP address.
-destmask destination_mask
This specifies the mask for the route's destination IP address.
-nexthop next_hop_IP_address
This specifies the next endpoint for the route.
The following command example deletes a route from a virtual interface named vif0 on a server named Server1. The route has a destination address of 192.40.5.1, a destination mask of 255.255.255.0, and a next-hop address of 192.40.6.1.
spinserver::> if routes delete -ssid Server1 -ifname vif0 -destaddr 192.40.5.1 -destmask 255.255.255.0 -nexthop 192.40.6.1
CLI:
if routes show [-ssid spinserver -ifname interface_name]
GUI: Navigate to the Interfaces → Routing pane. To display information about a specific route, select it from the table and run the Show command from the drop-down menu of the action pane.
The if routes show command displays information about static routes on one or more virtual interfaces. The command displays the following information:
SpinServer ID
Virtual-interface name
Destination IP address
Destination netmask
Next-hop IP address
-ssid spinserver
This specifies the SpinServer on which the virtual interface is located.
-ifname interface_name
This specifies the name of the virtual interface.
The following command example displays route information about a virtual interface named vif0 on a server named Server1.
spinserver::> if routes show -ssid Server1 -ifname vif0
SpinServer Name Destination IP Destination Next Hop
ID Address Netmask
Server1 vif0 192.40.5.1 255.255.255.0 192.40.6.1
CLI:
if status migratevif -ssid spinserver -ifname interface_name -destssid destination_spinserver -destport destination_port
GUI: Navigate to the Interfaces → Status node, then select the appropriate virtual interface from the table and run the Migrate VIF command from the drop-down menu of the action pane. Enter the appropriate values into the table that is displayed and click Migrate VIF.
The if status migratevif command can be used to manually migrate a virtual interface on a SpinServer to a different IP address.
-ssid spinserver
This is the SpinServer from which the virtual interface is to be migrated.
-ifname interface_name
This is the name of the virtual interface that is to be migrated.
-destssid destination_spinserver
This is the SpinServer to which the virtual interface is to be migrated.
-destport destination_port
This is the virtual interface's new port.
The following example migrates the virtual interface named vif1 on a SpinServer named Server1 to the serv1 port on a SpinServer named Server2.
spinserver::> if status migratevif -ssid Server1 -ifname vif1 -destssid Server2 -destport serv1
CLI:
if status revertvifs
GUI: Navigate to the Interfaces → Status node and run the Revert VIFs command from the top bar of the action pane.
The if status revertvifs command reverts all virtual interfaces in a SpinServer cluster to their home ports after a failover. The command takes no arguments; running the command reverts all virtual interfaces to their home ports.
The following example reverts all virtual interfaces to their home ports.
spinserver::> if status revertvifs
CLI:
if status show [-ssid spinserver -ifname interface_name]
GUI: Navigate to the Interfaces → Status node. To display information about a specific interface, select it from the table and run the Show command from the drop-down menu of the action pane.
The if status show command displays information about one interface or all interfaces. After identification is made, the following information about the interface or interfaces is displayed by the system:
SpinServer ID
Name
IP address
Netmask
Port
Status (up or down)
The role of the interface (cluster or server)
Active server (the ID of a virtual server's failover SpinServer or the local SpinServer's ID)
Active port (the failover port or the local port)
Interface type (virtual or network). If the interface is virtual, this value is listed as true; if the interface is network, this value is listed as false.
To display information about one interface, use the command with the -ssid and -ifname parameters. To display information about a list of interfaces in the cluster, use no parameters.
[-ssid spinserver]
This is the ID given to the SpinServer. This parameter is optional; however, if it is used, the -ifname parameter must also be specified.
[-ifname interface_name]
This is the name given to the interface. This parameter is optional; however, if it is used, the -ssid parameter must also be specified.
The following example displays status information about all interfaces.
spinserver::> if status show
SpinServer Name Address Stat Active Active Virtual
ID Server Port
spsrv10 clus_if1 10.3.128.61 up spsrv10 clus1 false
spsrv10 clus_if0 10.3.128.60 up spsrv10 clus0 false
spsrv10 mgmt_if0 10.3.2.115 up spsrv10 mgmt0 false
The following command example displays status information about an interface named clus_if0 on a SpinServer named Server1.
spinserver::> if status show -ssid Server1 -ifname clus_if0 SpinServer ID Server1 Name clus_if0 Address 192.168.1.1 Netmask 255.255.0.0 Port clus0 Status up Role Cluster Active Server Server1 Active Port clus0 Virtual false
Copyright © 2004 Network Appliance, Inc.; copyright © 2003, 2004 Spinnaker Networks, LLC. All rights reserved. Specifications subject to change without notice.